taler-docs

Documentation for GNU Taler components, APIs and protocols
Log | Files | Refs | README | LICENSE

get-monitoring-bad-sig-losses.rst (2378B)


      1 .. http:get:: /monitoring/bad-sig-losses
      2 
      3   Get a list of invalid signature losses stored by the auditor.
      4 
      5   The following query parameters are optional, and can be used to customise the response:
      6 
      7   **Request:**
      8 
      9   :query limit: A signed integer, indicating how many elements relative to the offset query parameter should be returned. The default value is -20.
     10   :query offset: An unsigned integer, indicating from which row onward to return elements. The default value is INT_MAX.
     11   :query return_suppressed: A boolean. If true, returns all eligible rows, otherwise only returns eligible rows that are not suppressed. The default value is false.
     12   :query operation: A string. If specified, only returns eligible rows with this :ts:type:`BadSigLosses`.operation value. The default value is NULL which means to not filter by operation.
     13   :query op_spec_pub: An EddsaPublicKey (in base32 encoding). If given, use its value to only return rows with this :ts:type:`BadSigLosses`.operation_specific_pub value. The default value is NULL.
     14 
     15   With the default settings, the endpoint returns at most the 20 latest elements that are not suppressed.
     16 
     17   **Response:**
     18 
     19   :http:statuscode:`200 OK`:
     20     The auditor responds with a top level array of :ts:type:`BadSigLosses` objects.
     21   :http:statuscode:`400 Bad request`:
     22     The request is malformed. Returned with an
     23     ``TALER_EC_GENERIC_PARAMETER_MALFORMED`` error code.
     24   :http:statuscode:`401 Unauthorized`:
     25     The request lacks valid authentication credentials.
     26     The response comes with a ``TALER_EC_AUDITOR_GENERIC_UNAUTHORIZED``.
     27   :http:statuscode:`500 Internal Server Error`:
     28     The server experienced an internal error.
     29     The response comes with a ``TALER_EC_GENERIC_DB_SETUP_FAILED`` or
     30     ``TALER_EC_GENERIC_DB_FETCH_FAILED`` error code.
     31 
     32   **Details:**
     33 
     34   .. ts:def:: BadSigLosses
     35 
     36     interface BadSigLosses {
     37 
     38       // Unique row identifier
     39       row_id : Integer;
     40 
     41       // Operation performed, even though a signature was invalid
     42       operation : string;
     43 
     44       // Amount considered lost by the exchange
     45       loss : Amount;
     46 
     47       // Public key associated with an operation
     48       operation_specific_pub : EddsaPublicKey;
     49 
     50       // True if this diagnostic was suppressed.
     51       suppressed : boolean;
     52 
     53     }
     54 
     55   .. note::
     56 
     57     This endpoint is still experimental. The endpoint will be further developed as needed.