# Testing

These are a collection of endpoints that allow you to test connectivity with your Console.

# Ping

GET /api/v1/ping

A simple endpoint to test if the API is reachable.

Required Parameters

auth_token string
A valid auth token

Response

A JSON message with a result indicator.

Example

    Response
    {
      "result": "success"
    }
    
    1
    2
    3

    # Send Fake Syslog Alerts

    GET /api/v1/syslog/fake_alert/<incident_count>

    Send fake alerts to your syslog setup.

    Required Parameters

    auth_token string
    A valid auth token

    Optional Parameters

    alert_all_devices boolean
    Create a fake alert for all Birds connected to your Console

    Response

    A JSON message with a result indicator.

    Example

      Response
      {
        "result": "success"
      }
      
      1
      2
      3

      # Send Syslog Test Message

      GET /api/v1/syslog/test

      Test your syslog setup by sending a dummy test message.

      Required Parameters

      auth_token string
      A valid auth token

      Response

      A JSON message with a result indicator.

      Example

        Response
        {
          "result": "success"
        }
        
        1
        2
        3