Sign in
initialization

Check the initialization status of the Central Server

Changed on
<h3>Administrator checks the initialization status of the Central Server.</h3>
get/initialization/status

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/initialization/status
  • Auth: API key in header Authorization

Response

initialization status of the Central Server

instance_identifierstring text required

Valid instance identifier, shall not contain colon, semicolon, forwardslash, backslash, percent or control characters.

central_server_addressstring text required

Central server’s public DNS name or external IP address

software_token_init_status'INITIALIZED' | 'NOT_INITIALIZED' | 'UNKNOWN' enum required

whether a token has been initialized or not – if the token init status cannot be resolved (e.g. signer module is offline), the value is UNKNOWN

Example response

{
  "instance_identifier": "FI-TEST",
  "software_token_init_status": "INITIALIZED"
}

Changes

  • ef4530615a96Revision changes
    • ○

      the //// response's property pattern ^[a-zA-Z0-9'()+,-.=?]* was added for the status