Peek Inside

Build trust in your online business and keep your customers informed during scheduled or unplanned outages.

Manage the current system status

You can manage the current system status and see all publicly viewable Crons & Pings. Status Page Messages are also be managed on this page.

Add a Status Page Message

As an incident unfolds you can keep your customers informed through Status Page Messages. These messages can be edited and deleted at anytime.

Publicly accessible Status Page

View the current system status in the top banner of the Public Status Page. Any Crons or Pings that are set to display on the Public Status Page will be displayed below.

Past incidents for 2 weeks

The Public Status Page displays past incidents for up to 2 weeks. These messages can be actively updated to keep your customers informed during unplanned and scheduled outages.

Basic Usage

Set the current system status

You can manually set the current system status on the main screen.

  1. Under the 'Current system status' heading choose a status and click 'Update status'.
  2. You can view the current system status in the top banner of the Public Status Page.

A a new Status Page Message

This tutorial will show you how to manually add a Status Page Message.

  1. Click the 'Add message' button.
  2. Choose an icon from the dropdown list.
  3. Input the Title & the Content and click 'Save changes'.
  4. You can view the message on your Public Status Page.
  5. Messages can be edited and deleted at anytime.

API Overview

Authentication

You'll need to authenticate using your API Key.

There are two ways to authenticate:

Request Headers:

$ curl -H "X-Api-Id: <API_KEY_ID>" -H "X-Api-Secret: <API_SECRET>" 'https://snja.io'

URL Parameters:

$ curl 'https://snja.io/foo?_id=<API_KEY_ID>&_secret=<API_SECRET>'

API Keys

API Keys can be created and managed in the API Keys section.

  1. Go to the API Keys section.
  2. Click on the button 'Generate API Key'.
  3. A new key will be genereated for use with the API.

Rate Limits

API Keys are rate limited to ensure fair delivery of services. You can view the current Rate Limit and Remaining Requests in the returned Response Headers from the API. Below is a description of the Response Headers.

Header Description
X-RateLimit-Limit The maximum number of requests per time window.
X-RateLimit-Remaining The number of requests remaining before reset.
X-RateLimit-Reset The time at which the current rate limit window resets in UTC Epoch seconds.

Error Codes

The following HTTP response codes are used.

Code Message Description
200 OK The request has succeeded.
400 Bad Request The request could not be understood by the server due to malformed syntax.
401 Unauthorised This indicates that you have not passed a valid API key, the key has expired, or the Authorization header is not formatted correctly.
404 Not Found The server has not found anything matching the Request-URI.
405 Method Not Allowed This indicates that the request method is known by the server but has been disabled and cannot be used.
429 Too Many Requests We have recieved too many requests from your API Key in a given amount of time. Wait a while and try again.

More Products

Device Shots

Easily mock-up your app screenshots onto different devices for marketing

Ring the Bell

Login on a TV or Pi and ring an audible bell every time the team makes a sale

NPS Feedback

Your Net Promoter Score measures brand loyalty and forecasts business growth

Uptime Pings

Get notified instantly when your website is down and not responding to requests

Cron Monitoring

Get notified when your cron jobs fail or benchmark their performance

Status Page

Keep your customers informed during scheduled or unplanned outages

GEOIP to Country

Lookup Country, Language & Currency Information from an IP address

DNS Watcher

Track DNS changes on your domains & get notified of expiring certificates

Competitor Monitor

Monitor your competitors' websites and get notified when they change

Builder API

Cross-platform Hybrid App build service for Cordova, React Native & Flutter

Ninjalytics

Generate swimlane charts of your customer's journey through your product

Request Bins

Capture & inspect HTTP requests. Replay the request to your local machine