Asynchronous API
    • PDF

    Asynchronous API

    • PDF
    • New

    Article Summary

    The Synchronous API is effective for handling large amounts of data, but some client architecture patterns require an asynchronous mode. Glasswall Halo's Asynchronous API allows requests to be processed in two stages. A UUID is generated for a request, which can be used later to retrieve the processing outcome. This eliminates the need for clients to wait for file processing and allows them to continue at their own convenience. The Glasswall Asynchronous API consists of various endpoints that perform specific functions. One endpoint, CDR Async, analyzes and rebuilds files to check for threats based on manufacturer specifications. Once complete, the rebuilt file and a report in XML or JSON format are available for download. More information can be found in the provided link.

    While the Synchronous API effectively meets the need for handling substantial volumes of data, certain client architecture patterns will require the incorporation of an asynchronous mode.

    With Glasswall Halo's Asynchronous API, requests can be handled via a two-stage process. Initially, a UUID is generated for a request, which can subsequently be used to retrieve the processing outcome. This enables the client to continue at its own convenience, eliminating the requirement to wait for file processing.

    Accessing Asynchronous API

    The Glasswall Asynchronous API can be accessed via:


    The Glasswall Asynchronous API consists of several endpoints which carry out specific functions.

    The endpoints and their descriptions are listed below.

    • CDR Async
      This endpoint asynchronously analyses and rebuilds binary or Base64 encoded files to determine if they contain threats, by comparing them to their known manufacturer's specification. Once the process is complete, the rebuilt file along with either a XML or JSON report, is produced and available as a ZIP download in the Responses section.

    For more information please refer to our API Documentation.

    Was this article helpful?