getInternalStatus

The getInternalStatus method returns the internal status of the AEA (Agamento Engine Application). This method is typically called infrequently to determine the internal state of the engine's service logic, particularly during transaction flows.

Request

📘

JSON-RPC 2.0

All methods in TweezerComm follow a JSON-RPC 2.0 structure. See Get Startedfor more details on how the requests are structured and sent.

In the request, the method field needs to be set to getInternalStatus, as shown in the example request below:

{
    "jsonrpc": "2.0",
    "method": "getInternalStatus",
    "id": "123454352",
    "params": [
        "engine"
    ]
}

Request Parameters

See the table below for a description of the available request parameters for this method.

NameTypeDescription
enginestringThe fixed service name

Response

A successful request will return a response similar to the one in the code block below:

{
    "jsonrpc": "2.0",
    "id": "123454352",
    "result": {
        "status": "idle"
    }
}

Response Parameters

The table below lists the possible values of the status field:

ValueDescription
IDLEThe engine is in idle mode and ready
BUSYThe engine is currently busy and cannot handle new requests
PHASE2_READYThe engine is ready for phase 2 of a transaction
AUTH_READYThe engine is ready to perform an authorization