.. meta::
    :description: This documentation will guide you through the use of the Memset API.

.. index::
   double: Methods; server.status

.. _server.status:

Server Status Methods
---------------------

Server Status API.

.. function:: server.status.info

    Return all monitoring statuses for a server.
    
    :param name: Name of the service. Service names are 1-64 characters A-Z, a-z, 0-9, -, . and _. Ensure this value has at most 64 characters.
    :type name: String
    
    :returns: A dictionary with the following keys:
    
        **name**:
            String: Name of the server, e.g. "testaa1".
        **service**:
            String: Name of service being monitored.
        **status**:
            String: Status of the service last time it was checked: "OK", "WARNING", "CRITICAL" or "UNKNOWN".
    
            **OK**
                The service was checked successfully and it appeared to be functioning properly.
            **WARNING**
                The service was checked successfully, but it appeared to be above some "warning" threshold or did not appear to be working properly.
            **CRITICAL**
                The service was not running or it was above some "critical" threshold.
            **UNKNOWN**
                The monitoring agent failed or some other low-level error prevented the completion of the status check.
        **last_checked**:
            Date: Date and time when the service was last checked.
        **detail**:
           String: Additional information about the status when last checked.

.. function:: server.status.list

    List all monitoring status information for servers in the account.
    
    :param names: Return monitoring status information for these names. If not provided, the status information of all live servers in the account is returned.
    :type names: List, Optional
    
    :param statuses: Return monitoring status information in these statuses. Valid statuses are: OK, WARNING, CRITICAL, UNKNOWN.
    :type statuses: List, Optional
    
    :returns: A list of dictionaries as described in :func:`server.status.info`.