360 Monitoring

Check the WebPros authentication status

Changed on

This function reports whether the server holds a valid WebPros authentication token for 360 Monitoring.

This function does not accept any parameters. It reads the token that the server stored during the WebPros single sign-on flow, checks that the token contains an identity token, and checks whether the token has expired.

The function returns data.valid with a value of 1 when a usable token exists. When the token is not usable, the function returns data.valid with a value of 0 and a machine-readable data.reason value.

The function does not return the access token or the refresh token. Use the 360Monitoring/webpros_auth_token function to retrieve the access token.

get/360Monitoring/webpros_auth_status

Request

  • Base URL
    https://whm-server.tld:2087/json-api
  • Auth
    HTTP basic

Response

The HTTP Request succeeded.

Example response

{
  "data": {
    "email": "user@example.com",
    "expired_at": 1767225600,
    "error": "The system could not read the token file.",
    "expires_in": 780,
    "reason": "no_token",
    "valid": 1
  },
  "metadata": {
    "command": "webpros_auth_status",
    "namespace": "360Monitoring",
    "reason": "OK",
    "result": 1,
    "version": 1
  }
}

Changes