Blocklet Server icon

Blocklet Server

Consume Blocklet Server API

Actions10

Overview

This node interacts with the Blocklet Server API to retrieve information about Blocklets. Specifically, the "Get Blocklet" operation fetches detailed data about a single Blocklet identified by its DID (Decentralized Identifier). It can optionally include additional runtime and disk information as well as optional components related to the Blocklet.

Use cases for this node include:

  • Retrieving metadata and status of a specific Blocklet in your decentralized application environment.
  • Monitoring Blocklet runtime or disk usage details for operational insights.
  • Fetching optional components to understand extended capabilities or configurations of a Blocklet.

Practical example: You have a Blocklet running in your infrastructure and want to programmatically check its current state, including runtime metrics and disk usage, to trigger alerts or automate maintenance tasks.

Properties

Name Meaning
Blocklet DID The unique Decentralized Identifier (DID) of the Blocklet you want to retrieve.
Attach Runtime Info Boolean flag indicating whether to include runtime information of the Blocklet in the output.
Attach Disk Info Boolean flag indicating whether to include disk usage information of the Blocklet.
Get Optional Components Boolean flag indicating whether to include optional components associated with the Blocklet.

Output

The node outputs JSON data representing the Blocklet's details. This includes at least the core metadata of the Blocklet identified by the provided DID. If enabled via properties, the output will also contain:

  • Runtime info: Metrics or status details about the Blocklet's current execution environment.
  • Disk info: Information about disk usage or storage related to the Blocklet.
  • Optional components: Additional configurable or extendable parts of the Blocklet.

The output is structured as an array of JSON objects, each corresponding to one input item processed. There is no binary data output from this node.

Dependencies

  • Requires connection to a Blocklet Server API endpoint.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests to the Blocklet Server.
  • No other external services are required.

Troubleshooting

  • Common issues:

    • Invalid or missing Blocklet DID: Ensure the DID string is correct and corresponds to an existing Blocklet.
    • Authentication errors: Verify that the API credential is correctly set up and has sufficient permissions.
    • Network connectivity problems: Confirm that the Blocklet Server API endpoint is reachable from the n8n instance.

  • Error messages:

    • "Not implemented blocklet action: <operation>": Indicates an unsupported operation was requested; verify the operation name.
    • API request failures typically return error messages from the Blocklet Server; check the message for details such as authorization failure or resource not found.

Resolving these usually involves checking input parameters, credentials, and network settings.

Links and References

Discussion