Murrion Software - API Documentation


Blacknight services status

The 'Blacknight Services Status' API allows a user to check the current status of their Blacknight server.

Important:  You will need an API key to use this API. Register for a free account here.

Features:

Usage

Post a JSON array containing an api_key and and a Blacknight server name to http://msapi.com/blacknight_status

{"api_key":"abcdefghijklmnopqrstuvwxyz","server_name":"pemlinweb29"}

Sample outputs

The resulting output is a JSON array containing the server name and the current status of services running on that server including HTTP, FTP, SMTP, POP3, mySQL and IMAP.

{"response":{"server_name":"pemlinweb29","http":"ok","ftp":"ok","smtp":"na","pop":"na","mysql":"na","mssql":"na","imap":"na"}}

Parameters

Preference Default Value Options Description
api_key Required None Your API Key
server_name Required None A Blacknight Server name

Error codes

Error notice Cause
Error, invalid API key An invalid API key has been passed to the API
Error, missing API key No API Key has been passed to the API
Error, missing server name No server name has been passed to the API
Error, server name not found The server name could not be found

Credits

This API is made possible by the Blacknight Status Monitor maintained by Blacknight. This API is also hosted Thanks to a Blacknight account.

Disclaimer

The Blacknight status monitor page may change at any time causing this API to fail.