taler-docs

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

get-config.rst (1321B)

      1 .. http:get:: /config
      2 
      3   Get the protocol version and some meta data about the auditor.
      4 
      5   **Response:**
      6 
      7   :http:statuscode:`200 OK`:
      8     The auditor responds with an `AuditorVersion`_ object. This request should
      9     virtually always be successful.
     10 
     11   **Details:**
     12 
     13   .. _AuditorVersion:
     14   .. code-block:: tsref
     15 
     16     interface AuditorVersion {
     17       // Name of the service implementing this protocol.
     18       name: "taler-auditor";
     19 
     20       // libtool-style representation of the Taler protocol version, see
     21       // https://www.gnu.org/software/libtool/manual/html_node/Versioning.html#Versioning
     22       // The format is "current:revision:age".  Note that the auditor
     23       // protocol is versioned independently of the exchange's protocol.
     24       version: string;
     25 
     26       // Version of the auditor software build.
     27       build_version: string;
     28 
     29       // URN of the implementation (needed to interpret 'revision' in version).
     30       implementation: string;
     31 
     32       // Return which currency this auditor is auditing for.
     33       currency: string;
     34 
     35       // EdDSA master public key of the auditor.
     36       auditor_public_key: EddsaPublicKey;
     37 
     38       // EdDSA master public key of the exchange.
     39       // Added in protocol v1.
     40       exchange_master_public_key: EddsaPublicKey;
     41     }
     42 
     43   .. note::
     44 
     45     This endpoint is still experimental.